<HTML>
<HEAD>
<TITLE>HELP - IncludeDocFromBody</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - IncludeDocFromBody</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','ExampleCode0',this)" class="pathLink">Example Code</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_class','HowToDocument0',this)" class="pathLink">HowToDocument</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">IncludeDocFromBody</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_member','IncludeDocFromBody2587069908','_description',this)" class="tabLinkActive">Description</a></span>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_member','IncludeDocFromBody2587069908','_source',this)" class="tabLinkInActive">Source</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Call Graph</span></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<span class="paragraph1">HowToDocument::IncludeDocFromBody</span>
<span class="padding">( Public Method  )</span>
<div class="paddingAuthor">Author:  N.F.S Grundtvig (The members of this class inherits the author by default.) </div>
<div class="paragraph2">Include documentation from function body.<br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2"><span id="descFunSynExpSpan" style="display:none;visibility:hidden"><a href="javascript:showElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSynExpSpan' );javascript:showElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'show' );"><img src="../../common/expand.gif" border=0></a></span><span id="descFunSynColSpan"><a href="javascript:showElement( 'descFunSynExpSpan' );javascript:hideElement( 'descFunSynColSpan' );javascript:hideElement( 'descFunSyn' );javascript:setMyCookie( cookieName, 'descFunSyn', 'hide' );"><img src="../../common/collapse.gif" border=0></a></span>
Syntax / parameters</div>
<div id="descFunSyn" class="paddingMembersTableDiv"><table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
<TR VALIGN="top"><TD class="paddingHeadMultiColumn2"><span class="codeFont">void <a href="#" OnMouseOver="link('_member','IncludeDocFromBody2587069908',this)">IncludeDocFromBody</a> ()<br>
</span></TD></TR></TABLE>
<br></div>
<div class="paragraph2">Description</div>
<div id="descDesc" class="paddingMembers">Include documentation from function body.<br>
Here we show how documentation can be included also from the body of a function. Please "click" on the<br>
"Source"-tab in your browser to view the code and see how this is done!<br>
<br>
<div class="userParagraph3">This is how it looks in the source:</div>
  <table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderMembers">
  <TR VALIGN="top">
  <TD class="paddingHeadMultiColumn2">
<pre class="codeExamples">
void  <a href="#" onMouseOver="link('_member','IncludeDocFromBody2587069908',this); overLibDiagram();return overlib('<strong>Syntax</strong><BR>void&nbsp;&nbsp;IncludeDocFromBody&nbsp;&nbsp;()',CAPTION,'<strong>Brief description</strong><BR>Include documentation from function body.');" onMouseOut="return nd();">HowToDocument::IncludeDocFromBody</a>() 
{ // Here we don't need to put the ending parenthesis after 2.1f on a newline, 
  // since the statement doesn't end until the ending '}'
  float fFloat = iSize * 3 + fMAX2;
  /// !Inlined documentation from function body.
  /// You can add documentation from within the function body this way.
  /// It is just concatenated to the normal documentation block.\n
  /// This only works if you have set #HIDE_IN_BODY_DOCS# to #NO# in the config file (default).\n
  /// #}As of right now it does not work with \\note \\todo etc., but that's on our todo-list :-)#}
}
</pre>  </TD>
  </TR>
  </TABLE>
<br>
<br>
<div class="userParagraph3">Inlined documentation from function body.</div>
 You can add documentation from within the function body this way. It is just concatenated to the normal documentation block.<br>
 This only works if you have set <b>HIDE_IN_BODY_DOCS</b> to <b>NO</b> in the config file (default).<br>
 <b><em>As of right now it does not work with \note \todo etc., but that's on our todo-list :-)</b></em><br>
</div>
<div class="padding">&nbsp;</div>
<table cellspacing=0 cellpadding=0 border=0 class="widthAndBorderTop" height=1>
<TR><TD height=1 width=100% class="oneLine"></TD></TR></TABLE>
<div class="paragraph2">Source</div>
<div class="paddingMembers">The documentation for this Member was generated from the following files:</div>
<div class="paddingMembers"><LI><a href="#" onMouseOver="link('_file','HowtoDocument_cpp0',this); ">HowtoDocument.cpp</a><br><LI><a href="#" onMouseOver="link('_file','HowtoDocument_h0',this); ">HowtoDocument.h</a><br></div>
<div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_member','_description');
</script>
